Skip to content

feat: v2 documentation with versioned navigation and updated SDKs#39

Open
VinciGit00 wants to merge 21 commits intomainfrom
version-2
Open

feat: v2 documentation with versioned navigation and updated SDKs#39
VinciGit00 wants to merge 21 commits intomainfrom
version-2

Conversation

@VinciGit00
Copy link
Copy Markdown
Member

Summary

  • Versioned navigation: docs.json now uses navigation.versions with v2 as default and v1 as legacy, matching the structure from doc-private
  • Updated SDK docs: Python and JavaScript SDK pages rewritten for v2 API based on scrapegraph-py#82 and scrapegraph-js#11 — new methods (extract, search, scrape, crawl.*, monitor.*, credits, history), FetchConfig/LlmConfig config objects, factory pattern for JS
  • Updated mocking docs: Replaced built-in mock mode (removed in v2) with standard library testing patterns (unittest.mock, responses, Jest/Vitest, MSW)
  • v1 legacy pages: 24 new pages under v1/ with deprecation banners pointing to v2 equivalents
  • Design updates: New primary color (#AC6DFF), IBM Plex Sans font, updated backgrounds

Test plan

  • Verify Mintlify builds successfully with versioned navigation
  • Check v2 tab loads as default
  • Check v1 tab shows legacy docs with deprecation warnings
  • Verify all navigation links resolve correctly in both versions
  • Review SDK code examples match the v2 PR APIs

🤖 Generated with Claude Code

VinciGit00 and others added 21 commits March 31, 2026 08:00
Migrate documentation to v2 structure with versioned nav (v2 default, v1 legacy).
Update Python and JavaScript SDK docs to reflect v2 API changes (extract, search,
scrape, crawl, monitor namespaces, FetchConfig/LlmConfig). Add v1/ legacy pages
with deprecation banners.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…nd navigation

- Add v2 service pages: Extract, Search, Crawl, Monitor
- Update Scrape service for v2 format-based API
- Update LangChain integration for v2 tools (ExtractTool, SearchTool, etc.)
- Update v2 navigation: remove old services (SmartScraper, SearchScraper, Markdownify, SmartCrawler, Sitemap, AgenticScraper, Langflow)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Rename smart-scraper → extract, search-scraper → search
- Remove commands dropped from v2: agentic-scraper, generate-schema, sitemap, validate
- Update scrape with --format flag (markdown, html, screenshot, branding)
- Update crawl with v2 polling model (max-pages, max-depth, max-links-per-page, allow-external)
- Update history with v2 service names (scrape, extract, search, monitor, crawl)
- Update all examples, JSON mode docs, and AI agent skill docs

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Reorder services: Scrape, Extract, Search, Crawl, Monitor
- Remove Community anchor, Playground, x402, Langflow from v2 nav
- Update Vercel AI integration for v2 SDK

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update all v2 documentation to match the latest SDK changes:
- JS SDK: named import, correct fetchConfig fields (render, wait), maxRetries=2, maxDepth for crawl
- Python SDK: Client.from_env(), context manager, format param, history filter params
- All service/knowledge-base/cookbook pages: migrate JS examples from v1 individual imports to v2 factory pattern

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Update v2 documentation links to use scrapegrphai.com/dashboard instead of dashboard subdomain and remove the Usage Analytics section from the dashboard overview to match the new content direction.

Made-with: Cursor
Refine the docs IA by removing the integrations drawer section and introducing a dedicated transition guide page for users migrating from v1 to v2.

Made-with: Cursor
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Rewrite proxy configuration page to document FetchConfig object with
mode parameter (auto/fast/js/direct+stealth/js+stealth), country-based
geotargeting, and all fetch options. Update knowledge-base proxy guide
and fix FetchConfig examples in both Python and JavaScript SDK pages
to match the actual v2 API surface.

Refs: ScrapeGraphAI/scrapegraph-js#11, ScrapeGraphAI/scrapegraph-py#82

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Rename smart-scraper → extract, search-scraper → search
- Remove dropped commands: agentic-scraper, generate-schema, sitemap, validate
- Replace --stealth boolean with --mode fetch mode enum
- Update scrape with --format flag (markdown, html, screenshot, branding)
- Update crawl with v2 polling model and new options
- Update env variables to SGAI_API_URL, SGAI_TIMEOUT_S
- Update response field names (remainingCredits, markdown)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove the advanced extract accordion snippet to keep the migration-focused section shorter and less confusing.

Made-with: Cursor
Clean up the Python SDK docs by removing the non-rendering header image and outdated llm_config parameter rows in extract/search tables.

Made-with: Cursor
Add a dedicated Plans & Pricing page and update account docs with current credit costs, proxy modifiers, and plan limits, including navigation links across the section.

Made-with: Cursor
Replace legacy v1 code snippets in all use-case pages with actual v2 method names and parameters so examples match the current SDK behavior.

Made-with: Cursor
Remove the "What changed at a glance" section from the transition guide as requested, while keeping the detailed migration mapping and examples.

Made-with: Cursor
Reorder the v1-to-v2 migration mapping and REST endpoint examples to match the Services navigation sequence (scrape, extract, search, crawl, monitor).

Made-with: Cursor
Add concrete Python and JavaScript v2 code examples for the markdownify-to-scrape migration step.

Made-with: Cursor
Delete the invalid top image reference on the Mocking & Testing SDK page to avoid broken rendering.

Made-with: Cursor
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant